/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
/**
 * 
 */
package cgl.narada.wsinfra.messaging.interactions.wse;

import java.util.Calendar;

import cgl.narada.wsinfra.exception.MessageFlowException;
import cgl.narada.wsinfra.exception.ProcessingException;
import cgl.narada.wsinfra.messaging.interactions.WseSubscriberWithSubscriptionManager;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.wse.impl.WseSinkProcessor;

/**
 * @author Shrideep Pallickara
 *
 */
public class WSESubscriberWithSubscriptionManager extends WSESubscriberInteraction
		implements WseSubscriberWithSubscriptionManager {

	private WseSinkProcessor wseSinkProcessor;
	private String moduleName = "WSESubscriberWithSubscriptionManager: "; 
	
	
	public WSESubscriberWithSubscriptionManager(WseSinkProcessor wseSinkProcessor) {
		super(wseSinkProcessor);
		this.wseSinkProcessor = wseSinkProcessor;
	}
	
	/**
	 * @see cgl.narada.wsinfra.messaging.interactions.WseSubscriberWithSubscriptionManager#getStatus(java.lang.String)
	 */
	public void getStatus(String subscriptionIdentifier)
			throws ProcessingException, MessageFlowException {
		
		EnvelopeDocument envelopeDocument = createGetStatus(subscriptionIdentifier);
		issueExchange(envelopeDocument);
	}

	
	/**
	 * @see cgl.narada.wsinfra.messaging.interactions.WseSubscriberWithSubscriptionManager#createGetStatus(java.lang.String)
	 */
	public EnvelopeDocument createGetStatus(String subscriptionIdentifier) throws ProcessingException {
		checkSubscriptionIdentifier(subscriptionIdentifier);
		
		EnvelopeDocument envelopeDocument = 
			wseSinkProcessor.createGetStatus(subscriptionIdentifier);
		return envelopeDocument;
	}
	
	
	/** 
	 * @see cgl.narada.wsinfra.messaging.interactions.SubscriberWithSubscriptionManager#unsubscribe(java.lang.String)
	 */
	public void unsubscribe(String subscriptionIdentifier)
			throws ProcessingException, MessageFlowException {
		EnvelopeDocument envelopeDocument = createUnsubscribe(subscriptionIdentifier);
		issueExchange(envelopeDocument);
	}
	
	
	/**
	 * @see cgl.narada.wsinfra.messaging.interactions.SubscriberWithSubscriptionManager#createUnsubscribe(java.lang.String)
	 */
	public EnvelopeDocument createUnsubscribe(String subscriptionIdentifier) 
		throws ProcessingException {
		
		checkSubscriptionIdentifier(subscriptionIdentifier);
		
		EnvelopeDocument envelopeDocument = 
			wseSinkProcessor.createUnsubscribe(subscriptionIdentifier);
		return envelopeDocument;
	}
	
	
	/**
	 * @see cgl.narada.wsinfra.messaging.interactions.SubscriberWithSubscriptionManager#renew(java.lang.String, java.util.Calendar)
	 */
	public void renew(String subscriptionIdentifier, Calendar renewUntil)
			throws ProcessingException, MessageFlowException {
		EnvelopeDocument envelopeDocument = createRenew(subscriptionIdentifier,
																	   renewUntil);
		issueExchange(envelopeDocument);	
	}
	
	
	/**
	 * @see cgl.narada.wsinfra.messaging.interactions.SubscriberWithSubscriptionManager#createRenew(java.lang.String, java.util.Calendar)
	 */
	public EnvelopeDocument createRenew(String subscriptionIdentifier, 
	                                    Calendar renewUntil) 
		throws ProcessingException {
		checkSubscriptionIdentifier(subscriptionIdentifier);
		checkIfRenewalIsValid(renewUntil);
		
		EnvelopeDocument envelopeDocument = 
			wseSinkProcessor.createRenew(subscriptionIdentifier, renewUntil);
		
		return envelopeDocument;
	}
	

	
	
	
	/**
	 * Checks for problems with the subscription identifier
	 * @param subscriptionIdentifier
	 * @throws ProcessingException
	 */
	private void checkSubscriptionIdentifier(String subscriptionIdentifier) 
		throws ProcessingException {
		if (subscriptionIdentifier != null) {
			return;
		}
		
		String errorReport = moduleName + "The specified subscription Identifier is NULL!";
		throw new ProcessingException(errorReport);
	}

	/**
	 * Checks to see if the specified renewal time is a valid one.
	 * @param renewUntil
	 * @throws ProcessingException
	 */
	private void checkIfRenewalIsValid(Calendar renewUntil) throws ProcessingException {
		Calendar currentTime = Calendar.getInstance();
      boolean isInPast = renewUntil.before(currentTime);

      if (isInPast) {
      	String errorReport = moduleName + "Specified renewal time is in the past";
      	throw new ProcessingException(errorReport);
	   }
	}	
		
}
